home *** CD-ROM | disk | FTP | other *** search
/ IRIX Base Documentation 2001 May / SGI IRIX Base Documentation 2001 May.iso / usr / share / catman / p_man / cat3x / curs_addwch.z / curs_addwch
Encoding:
Text File  |  1998-10-20  |  10.5 KB  |  129 lines

  1.  
  2.  
  3.  
  4. ccccuuuurrrrssss____aaaaddddddddwwwwcccchhhh((((3333XXXX))))                                                ccccuuuurrrrssss____aaaaddddddddwwwwcccchhhh((((3333XXXX))))
  5.  
  6.  
  7.  
  8. NNNNAAAAMMMMEEEE
  9.      _cccc_uuuu_rrrr_ssss______aaaa_dddd_dddd_wwww_cccc_hhhh: _aaaa_dddd_dddd_wwww_cccc_hhhh, _wwww_aaaa_dddd_dddd_wwww_cccc_hhhh, _mmmm_vvvv_aaaa_dddd_dddd_wwww_cccc_hhhh, _mmmm_vvvv_wwww_aaaa_dddd_dddd_wwww_cccc_hhhh, _eeee_cccc_hhhh_oooo_wwww_cccc_hhhh_aaaa_rrrr, _wwww_eeee_cccc_hhhh_oooo_wwww_cccc_hhhh_aaaa_rrrr
  10.      - add a _wwww_cccc_hhhh_aaaa_rrrr______tttt character (with attributes) to a _cccc_uuuu_rrrr_ssss_eeee_ssss window and
  11.      advance cursor
  12.  
  13. SSSSYYYYNNNNOOOOPPPPSSSSIIIISSSS
  14.      _####_iiii_nnnn_cccc_llll_uuuu_dddd_eeee _<<<<_cccc_uuuu_rrrr_ssss_eeee_ssss_...._hhhh_>>>>
  15.  
  16.      _iiii_nnnn_tttt _aaaa_dddd_dddd_wwww_cccc_hhhh_((((_cccc_hhhh_tttt_yyyy_pppp_eeee _wwww_cccc_hhhh_))))_;;;;
  17.      _iiii_nnnn_tttt _wwww_aaaa_dddd_dddd_wwww_cccc_hhhh_((((_WWWW_IIII_NNNN_DDDD_OOOO_WWWW _****_wwww_iiii_nnnn_,,,, _cccc_hhhh_tttt_yyyy_pppp_eeee _wwww_cccc_hhhh_))))_;;;;
  18.      _iiii_nnnn_tttt _mmmm_vvvv_aaaa_dddd_dddd_wwww_cccc_hhhh_((((_iiii_nnnn_tttt _yyyy_,,,, _iiii_nnnn_tttt _xxxx_,,,, _cccc_hhhh_tttt_yyyy_pppp_eeee _wwww_cccc_hhhh_))))_;;;;
  19.      _iiii_nnnn_tttt _mmmm_vvvv_wwww_aaaa_dddd_dddd_wwww_cccc_hhhh_((((_WWWW_IIII_NNNN_DDDD_OOOO_WWWW _****_wwww_iiii_nnnn_,,,, _iiii_nnnn_tttt _yyyy_,,,, _iiii_nnnn_tttt _xxxx_,,,, _cccc_hhhh_tttt_yyyy_pppp_eeee _wwww_cccc_hhhh_))))_;;;;
  20.      _iiii_nnnn_tttt _eeee_cccc_hhhh_oooo_wwww_cccc_hhhh_aaaa_rrrr_((((_cccc_hhhh_tttt_yyyy_pppp_eeee _wwww_cccc_hhhh_))))_;;;;
  21.      _iiii_nnnn_tttt _wwww_eeee_cccc_hhhh_oooo_wwww_cccc_hhhh_aaaa_rrrr_((((_WWWW_IIII_NNNN_DDDD_OOOO_WWWW _****_wwww_iiii_nnnn_,,,, _cccc_hhhh_tttt_yyyy_pppp_eeee _wwww_cccc_hhhh_))))_;;;;
  22.  
  23. DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNN
  24.      The _aaaa_dddd_dddd_wwww_cccc_hhhh, _wwww_aaaa_dddd_dddd_wwww_cccc_hhhh, _mmmm_vvvv_aaaa_dddd_dddd_wwww_cccc_hhhh, and _mmmm_vvvv_wwww_aaaa_dddd_dddd_wwww_cccc_hhhh routines put the character
  25.      _w_c_h, holding a _wwww_cccc_hhhh_aaaa_rrrr______tttt character, into the window at the current cursor
  26.      position of the window and advance the position of the window cursor.
  27.      Their function is similar to that of _pppp_uuuu_tttt_wwww_cccc_hhhh_aaaa_rrrr in the C multibyte library.
  28.      At the right margin, an automatic newline is performed.  At the bottom of
  29.      the scrolling region, if _ssss_cccc_rrrr_oooo_llll_llll_oooo_kkkk is enabled, the scrolling region is
  30.      scrolled up one line.
  31.  
  32.      If _w_c_h is a tab, newline, or backspace, the cursor is moved appropriately
  33.      within the window.  A newline also does a _cccc_llll_rrrr_tttt_oooo_eeee_oooo_llll before moving.  Tabs
  34.      are considered to be at every eighth column.  If _w_c_h is another control
  35.      character, it is drawn in the _^^^^_X notation.  Calling _wwww_iiii_nnnn_wwww_cccc_hhhh after adding a
  36.      control character does not return the control character, but instead
  37.      returns the representation of the control character.
  38.  
  39.      Video attributes can be combined with a _wwww_cccc_hhhh_aaaa_rrrr______tttt character by OR-ing them
  40.      into the parameter.  This results in these attributes also being set.
  41.      (The intent here is that text, including attributes, can be copied from
  42.      one place to another using _iiii_nnnn_wwww_cccc_hhhh and _aaaa_dddd_dddd_wwww_cccc_hhhh.)  [see _ssss_tttt_aaaa_nnnn_dddd_oooo_uuuu_tttt, predefined
  43.      video attribute constants, on the _cccc_uuuu_rrrr_ssss______aaaa_tttt_tttt_rrrr(3X) page].
  44.  
  45.      The _eeee_cccc_hhhh_oooo_wwww_cccc_hhhh_aaaa_rrrr and _wwww_eeee_cccc_hhhh_oooo_wwww_cccc_hhhh_aaaa_rrrr routines are functionally equivalent to a
  46.      call to _aaaa_dddd_dddd_wwww_cccc_hhhh followed by a call to _rrrr_eeee_ffff_rrrr_eeee_ssss_hhhh, or a call to _wwww_aaaa_dddd_dddd_wwww_cccc_hhhh
  47.      followed by a call to _wwww_rrrr_eeee_ffff_rrrr_eeee_ssss_hhhh.  The knowledge that only a single
  48.      character is being output is taken into consideration and, for non-
  49.      control characters, a considerable performance gain might be seen by
  50.      using these routines instead of their equivalents.
  51.  
  52.    LLLLiiiinnnneeee GGGGrrrraaaapppphhhhiiiiccccssss
  53.      The following variables may be used to add line drawing characters to the
  54.      screen with routines of the _aaaa_dddd_dddd_wwww_cccc_hhhh family.  When variables are defined
  55.      for the terminal, the _AAAA______AAAA_LLLL_TTTT_CCCC_HHHH_AAAA_RRRR_SSSS_EEEE_TTTT bit is turned on [see _cccc_uuuu_rrrr_ssss______aaaa_tttt_tttt_rrrr(3X)].
  56.      Otherwise, the default character listed below is stored in the variable.
  57.      The names chosen are consistent with the VT100 nomenclature.
  58.  
  59.  
  60.                                                                         PPPPaaaaggggeeee 1111
  61.  
  62.  
  63.  
  64.  
  65.  
  66.  
  67. ccccuuuurrrrssss____aaaaddddddddwwwwcccchhhh((((3333XXXX))))                                                ccccuuuurrrrssss____aaaaddddddddwwwwcccchhhh((((3333XXXX))))
  68.  
  69.  
  70.  
  71.                ___________________________________________________
  72.                 Name             Default   Glyph Description
  73.                 __________________________________________________
  74.                 ACS_ULCORNER     +         upper left-hand corner
  75.                 ACS_LLCORNER     +         lower left-hand corner
  76.                 ACS_URCORNER     +         upper right-hand corner
  77.                 ACS_LRCORNER     +         lower right-hand corner
  78.                 ACS_RTEE         +         right tee (-|)
  79.                 ACS_LTEE         +         left tee (|-)
  80.                 ACS_BTEE         +         bottom tee (_|)
  81.                 ACS_TTEE         +         top tee (_|)
  82.                 ACS_HLINE        -         horizontal line
  83.                 ACS_VLINE        |         vertical line
  84.                 ACS_PLUS         +         plus
  85.                 ACS_S1           -         scan line 1
  86.                 ACS_S9           _         scan line 9
  87.                 ACS_DIAMOND      +         diamond
  88.                 ACS_CKBOARD      :         checker board (stipple)
  89.                 ACS_DEGREE       '         degree symbol
  90.                 ACS_PLMINUS      #         plus/minus
  91.                 ACS_BULLET       o         bullet
  92.                 ACS_LARROW       <         arrow pointing left
  93.                 ACS_RARROW       >         arrow pointing right
  94.                 ACS_DARROW       v         arrow pointing down
  95.                 ACS_UARROW       ^         arrow pointing up
  96.                 ACS_BOARD        #         board of squares
  97.                 ACS_LANTERN      #         lantern symbol
  98.                 ACS_BLOCK        #         solid square block
  99.                 __________________________________________________
  100.  
  101. RRRREEEETTTTUUUURRRRNNNN VVVVAAAALLLLUUUUEEEE
  102.      All routines return the integer _EEEE_RRRR_RRRR upon failure and an integer value
  103.      other than _EEEE_RRRR_RRRR upon successful completion, unless otherwise noted in the
  104.      preceding routine descriptions.
  105.  
  106. NNNNOOOOTTTTEEEESSSS
  107.      The header file _<<<<_cccc_uuuu_rrrr_ssss_eeee_ssss_...._hhhh_>>>> automatically includes the header files
  108.      _<<<<_ssss_tttt_dddd_iiii_oooo_...._hhhh_>>>> and _<<<<_uuuu_nnnn_cccc_tttt_rrrr_llll_...._hhhh_>>>>.
  109.  
  110.      Note that _aaaa_dddd_dddd_wwww_cccc_hhhh, _mmmm_vvvv_aaaa_dddd_dddd_wwww_cccc_hhhh, _mmmm_vvvv_wwww_aaaa_dddd_dddd_wwww_cccc_hhhh, and _eeee_cccc_hhhh_oooo_wwww_cccc_hhhh_aaaa_rrrr may be macros.
  111.  
  112. SSSSEEEEEEEE AAAALLLLSSSSOOOO
  113.      _cccc_uuuu_rrrr_ssss_eeee_ssss(3X), _cccc_uuuu_rrrr_ssss______aaaa_tttt_tttt_rrrr(3X), _cccc_uuuu_rrrr_ssss______cccc_llll_eeee_aaaa_rrrr(3X), _cccc_uuuu_rrrr_ssss______iiii_nnnn_wwww_cccc_hhhh(3X),
  114.      _cccc_uuuu_rrrr_ssss______oooo_uuuu_tttt_oooo_pppp_tttt_ssss(3X), _cccc_uuuu_rrrr_ssss______rrrr_eeee_ffff_rrrr_eeee_ssss_hhhh(3X), _pppp_uuuu_tttt_wwww_cccc(3W).
  115.  
  116.  
  117.  
  118.  
  119.  
  120.  
  121.  
  122.  
  123.  
  124.  
  125.                                                                         PPPPaaaaggggeeee 2222
  126.  
  127.  
  128.  
  129.